🐛 Fix response unmarshalling issue when API has unknown fields #115
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
acabarbaye
force-pushed
the
fix-unmarshalling
branch
from
590bec1 to
a90b7b5
Compare
| } | ||
|
|
||
| func checkResponseMarshalling(ctx context.Context, apiErr error, resp *http.Response, result any) (err error) { | ||
| if apiErr != nil { |
Contributor
There was a problem hiding this comment.
if this is going to be its own function then you should check the statuscode too, before it was after something that did that so we knew it would be successful but here we don't and it could cause confusion if someone uses the function elsewhere
Contributor
Author
There was a problem hiding this comment.
this is a private function though
Comment on lines
112
to
125
| // At this point, the marshalling problem may be due to the present of unknown fields in the response due to an API extension. | ||
| // See https://github.com/OpenAPITools/openapi-generator/issues/21446 | ||
| var respB []byte | ||
| respB, err = safeio.ReadAll(ctx, resp.Body) | ||
| if err != nil { | ||
| return | ||
| } | ||
| _, err = marshmallow.Unmarshal(respB, result, marshmallow.WithSkipPopulateStruct(false), marshmallow.WithExcludeKnownFieldsFromMap(true)) | ||
| if err != nil { | ||
| err = commonerrors.WrapError(commonerrors.ErrMarshalling, err, "API call was successful but an error occurred during response marshalling") | ||
| return | ||
| } | ||
| } | ||
| return |
Contributor
There was a problem hiding this comment.
Since you do this I think the function needs to have a different name since it isn't just checking, it is also doing another unmarshal attempt
joshjennings98
approved these changes
Jun 26, 2025
Contributor
joshjennings98
left a comment
joshjennings98
left a comment
There was a problem hiding this comment.
Just two comments but I think it will help a lot
aorabdel
approved these changes
Jun 26, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
fix problem we see with clients when upgrading APIs
Test Coverage